Resource URL: /platform/<<version=1>>/quota/settings/notifications/<NID>

    Overview: This resource applies the standard collection item pattern to
              individual global quota notification rules.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve notification rule information.

       URL: GET /platform/<<version=1>>/quota/settings/notifications/<NID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "notifications": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "action_email_owner": {
                "required": true, 
                "type": "boolean", 
                "description": "Email quota domain owner when rule matches."
              }, 
              "email_template": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Path of optional /ifs template file used for email actions."
              }, 
              "schedule": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Schedule for rules that repeatedly notify."
              }, 
              "action_email_address": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Email a specific email address when rule matches."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "The system ID given to the rule."
              }, 
              "holdoff": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "Time to wait between detections for rules triggered by user actions."
              }, 
              "threshold": {
                "enum": [
                  "hard", 
                  "soft", 
                  "advisory"
                ], 
                "type": "string", 
                "description": "The quota threshold detected.", 
                "required": true
              }, 
              "action_alert": {
                "required": true, 
                "type": "boolean", 
                "description": "Send alert when rule matches."
              }, 
              "condition": {
                "enum": [
                  "exceeded", 
                  "denied", 
                  "violated", 
                  "expired"
                ], 
                "type": "string", 
                "description": "The condition detected.", 
                "required": true
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify notification rule. All input fields are optional, but one or
            more must be supplied.

       URL: PUT /platform/<<version=1>>/quota/settings/notifications/<NID>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "action_email_owner": {
      "type": "boolean", 
      "description": "Email quota domain owner when rule matches."
    }, 
    "schedule": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Schedule for rules that repeatedly notify."
    }, 
    "email_template": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Path of optional /ifs template file used for email actions."
    }, 
    "action_email_address": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Email a specific email address when rule matches."
    }, 
    "holdoff": {
      "type": [
        "integer", 
        "null"
      ], 
      "description": "Time to wait between detections for rules triggered by user actions."
    }, 
    "action_alert": {
      "type": "boolean", 
      "description": "Send alert when rule matches."
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete the notification rule.

          URL: DELETE /platform/<<version=1>>/quota/settings/notifications/<NID>

There are no query arguments for this method.

There is no JSON response body for this method.
